BusyOutLine

The BusyOutLine procedure is used to take a phone line out of service. When a phone line is out of service, you will not be able to make or receive phone calls on that line.

TELEPHONY_RETURN_VALUE BusyOutLine(

SIPHANDLE hStateMachine,

int PhoneLine,

BOOL BusyOutState

);

Parameters:

hStateMachine

[in] The handle to the telephony engine. This is the handle that was returned by a previous call to the StartSipTelephony procedure.

PhoneLine

[in] The zero based phone line to answer.

BusyOutState

[in] Specifies the “service state” of the phone. If TRUE, the phone line will not be assigned to any in bound calls. Also, the line can not be used to initiate a call. If FALSE, the phone line characteristics are normal.

Return Value:

If the function succeeds, the return value will be SipSuccess.

If the function fails, the return value will be one of the following values as specified by the TELEPHONY_RETURN_VALUE data type.

Value	Description
SipCallFailure	This is a generic "catch all" API error. If an error condition is not specified by any other API error value, this error will be returned.
SipInvalidHandle	An API procedure was passed an invalid handle. The telephony engine attempts to verify user specified telephony handles and returns this error when an invalid handle is detected.
SipBadPhoneLine	A telephony operation was specified using an invalid phone line. Phone lines are numbered starting from zero.
SipCallAlreadyInProgress	A call operation is already active on the phone line. The phone line must be on hook to change the line's "busy out" state.